Skip to content

Add Ruby + PostgreSQL quickstart guide #773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Nsanjayboruds wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add Ruby + PostgreSQL quickstart guide #773

Nsanjayboruds wants to merge 2 commits into from

Conversation

@Nsanjayboruds
Copy link

@Nsanjayboruds Nsanjayboruds commented Jan 29, 2026

Add Ruby + PostgreSQL Quickstart Guide

📝 Description

This PR adds a comprehensive quickstart guide for Ruby (Sinatra) with PostgreSQL integration, demonstrating how to use Keploy for automated API testing with Ruby applications.

🎯 Changes Made

  • ✅ Created new quickstart documentation: ruby-sinatra-postgres.md

    • Includes both Docker Compose and Local setup instructions
    • Complete CRUD API examples (GET, POST, PUT, DELETE)
    • Clear step-by-step Keploy record and test commands
    • Follows existing documentation style and structure

  • ✅ Added Ruby language support to QuickStartFilter.js

    • Added Ruby gem icon with official Ruby red color (#CC342D)
    • Enables filtering quickstarts by Ruby language

  • ✅ Registered quickstart in QuickStartList.js

    • Added entries for both Docker and Local environments
    • Properly linked to documentation sections

  • ✅ Updated sidebar navigation in version-4.0.0-sidebars.json

    • Added Ruby category under QuickStarts section
    • Maintains consistent structure with other languages

🔗 Related Repository

Sample application repository: https://github.com/Nsanjayboruds/keploy-ruby-postgresql-quickstart

✅ Pre-submission Checklist

  • Build passes locally (npm run build successful)
  • Design matches existing quickstarts
  • Both Docker and Local setup instructions included
  • Follows existing code patterns
  • Documentation is clear and beginner-friendly

📸 Preview

The quickstart covers:

  • Health check endpoint
  • Books CRUD operations
  • PostgreSQL database integration
  • Keploy record/replay workflows

🙏 Additional Notes

This is my first contribution to Keploy docs. Looking forward to feedback and happy to make any requested changes!

Copilot AI review requested due to automatic review settings January 29, 2026 08:16
@Nsanjayboruds Nsanjayboruds mentioned this pull request Jan 29, 2026
Closed
5 tasks
@Nsanjayboruds Nsanjayboruds mentioned this pull request Jan 29, 2026
Open
Copilot AI reviewed Jan 29, 2026
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Ruby (Sinatra) + PostgreSQL quickstart and wires it into the Quickstarts UI and sidebar so users can discover and follow the guide.

Changes:

  • Added a new Ruby (Sinatra) + PostgreSQL Books CRUD quickstart doc (Docker + Local flows).
  • Added “Ruby” to the Quickstart language filter UI and registered Ruby quickstart entries in the list.
  • Added a Ruby category under QuickStarts in the v4.0.0 sidebar.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
versioned_sidebars/version-4.0.0-sidebars.json Adds Ruby category + doc entry under QuickStarts for v4.0.0 navigation.
versioned_docs/version-4.0.0/quickstart/ruby-sinatra-postgres.md New Ruby+Postgres quickstart guide content (Docker + Local).
src/components/QuickStartList.js Registers Ruby quickstarts (Docker + Local) in the Quickstarts catalog.
src/components/QuickStartFilter.js Adds Ruby as a selectable language with icon/color in the filter UI.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Nsanjayboruds Nsanjayboruds force-pushed the add-ruby-postgresql-quickstart branch 2 times, most recently from d1b6200 to 4f2b408 Compare January 30, 2026 02:45
@Nsanjayboruds
Copy link
Author

Nsanjayboruds commented Jan 30, 2026

@copilot open a new pull request to apply changes based on the comments in this thread

1 similar comment
@Nsanjayboruds
Copy link
Author

Nsanjayboruds commented Jan 30, 2026

@copilot open a new pull request to apply changes based on the comments in this thread

Achanandhi-M
Achanandhi-M requested changes Feb 2, 2026
View reviewed changes
Copy link
Member

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Nsanjayboruds , thanks a lot for adding the changes—really appreciate the effort. There are a few small things that still need to be added; you can use this guide as a reference: https://github.com/keploy/docs/blob/main/ADDING_A_QUICKSTART.md

Also, if possible, could you please include a short video showcasing your changes? That would be very helpful

@Nsanjayboruds
Copy link
Author

Nsanjayboruds commented Feb 2, 2026

https://drive.google.com/file/d/1pehPFehO4WpsappZzA2OQrso6IssWa1B/view?usp=sharing

@Nsanjayboruds Nsanjayboruds force-pushed the add-ruby-postgresql-quickstart branch 2 times, most recently from 8d671ce to eadbf29 Compare February 2, 2026 12:17
@Nsanjayboruds
Copy link
Author

Nsanjayboruds commented Feb 2, 2026 •
edited
Loading

Hey @Nsanjayboruds , thanks a lot for adding the changes—really appreciate the effort. There are a few small things that still need to be added; you can use this guide as a reference: https://github.com/keploy/docs/blob/main/ADDING_A_QUICKSTART.md

Also, if possible, could you please include a short video showcasing your changes? That would be very helpful

hey @Achanandhi-M i added a video showcasing my change

@Nsanjayboruds Nsanjayboruds mentioned this pull request Feb 3, 2026
Open
5 tasks
@Nsanjayboruds
Copy link
Author

Nsanjayboruds commented Feb 3, 2026

RUBY_QUICKSTART_DEMO

@Nsanjayboruds
docs: add ruby postgresql quickstart
ba4b880 
Signed-off-by: Nsanjayboruds <nishantborude555@gmail.com>
@Nsanjayboruds Nsanjayboruds force-pushed the add-ruby-postgresql-quickstart branch from 7219218 to ba4b880 Compare February 3, 2026 11:17
@Nsanjayboruds
add images of lcoal steups
0718d0a 
Signed-off-by: Nsanjayboruds <nishantborude555@gmail.com>
@Nsanjayboruds Nsanjayboruds force-pushed the add-ruby-postgresql-quickstart branch from 23f225c to 0718d0a Compare February 3, 2026 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Achanandhi-M Achanandhi-M Achanandhi-M requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Nsanjayboruds @Achanandhi-M